Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Complete Public API Documentation #90

Merged
merged 1 commit into from
Jan 27, 2018
Merged

Conversation

Ben-G
Copy link
Contributor

@Ben-G Ben-G commented Jan 26, 2018

Changes in this pull request

All public symbols that are considered part of the core API are now documented.
This commit suppresses documentation for APIs that will be removed in future releases.

  • minor code change, making cellViewModels on CollectionViewModel non-optional.

@PlanBot-iOS
Copy link

PlanBot-iOS commented Jan 26, 2018

1 Error
🚫 Source code changes (in APIs or behaviors) should have an entry in CHANGELOG.md.

Generated by 🚫 Danger

@jessesquires
Copy link
Contributor

minor code change, making cellViewModels on CollectionViewModel non-optional.

thanks! 👏

that was on my list

Copy link
Contributor

@jessesquires jessesquires left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm... 🤔

I think we should document public symbols.

Either that, or rip it out.

@Ben-G
Copy link
Contributor Author

Ben-G commented Jan 26, 2018

@jessesquires Want to rip out eventually (as documented) but don't think that's absolutely mandatory right now. For #77 specifically I want to first figure out how we can create a ReactiveLists extension that maintains the existing behavior.

@Ben-G Ben-G force-pushed the benji/complete-docs-v1 branch from 41c7ca6 to 95464a8 Compare January 26, 2018 22:36
@@ -163,8 +163,8 @@ open class TableViewDriver: NSObject {
}

self.tableView.registerViews(for: newModel)

if self.automaticDiffingEnabled {

Copy link

@PlanBot-iOS PlanBot-iOS Jan 26, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Lines should not have trailing whitespace.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cc @anayini danger + swiftlint works 😄

@Ben-G Ben-G force-pushed the benji/complete-docs-v1 branch from 95464a8 to a69f2b9 Compare January 26, 2018 23:20
All public symbols that are considered part of the core API are now documented.

This commit suppresses documentation for APIs that will be removed in future releases.
@Ben-G Ben-G force-pushed the benji/complete-docs-v1 branch from a69f2b9 to e1ab20c Compare January 27, 2018 00:12
@Ben-G Ben-G merged commit 10c14d6 into master Jan 27, 2018
@Ben-G Ben-G deleted the benji/complete-docs-v1 branch January 27, 2018 00:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants